/*
 * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package javax.xml.soap;

/**
 * A factory for creating <code>SOAPConnection</code> objects. Implementation of this class
 * is optional. If <code>SOAPConnectionFactory.newInstance()</code> throws an
 * UnsupportedOperationException then the implementation does not support the
 * SAAJ communication infrastructure. Otherwise {@link SOAPConnection} objects
 * can be created by calling <code>createConnection()</code> on the newly
 * created <code>SOAPConnectionFactory</code> object.
 */
public abstract class SOAPConnectionFactory {

  /**
   * A constant representing the default value for a <code>SOAPConnection</code>
   * object. The default is the point-to-point SOAP connection.
   */
  static final String DEFAULT_SOAP_CONNECTION_FACTORY
      = "com.sun.xml.internal.messaging.saaj.client.p2p.HttpSOAPConnectionFactory";

  /**
   * A constant representing the <code>SOAPConnection</code> class.
   */
  static private final String SF_PROPERTY
      = "javax.xml.soap.SOAPConnectionFactory";

  /**
   * Creates an instance of the default
   * <code>SOAPConnectionFactory</code> object.
   *
   * @return a new instance of a default <code>SOAPConnectionFactory</code> object
   * @throws SOAPException if there was an error creating the <code>SOAPConnectionFactory</code>
   * @throws UnsupportedOperationException if newInstance is not supported.
   */
  public static SOAPConnectionFactory newInstance()
      throws SOAPException, UnsupportedOperationException {
    try {
      return (SOAPConnectionFactory)
          FactoryFinder.find(SF_PROPERTY,
              DEFAULT_SOAP_CONNECTION_FACTORY);
    } catch (Exception ex) {
      throw new SOAPException("Unable to create SOAP connection factory: "
          + ex.getMessage());
    }
  }

  /**
   * Create a new <code>SOAPConnection</code>.
   *
   * @return the new <code>SOAPConnection</code> object.
   * @throws SOAPException if there was an exception creating the <code>SOAPConnection</code>
   * object.
   */
  public abstract SOAPConnection createConnection()
      throws SOAPException;
}
